/*
 * Copyright 2009 SHOP.COM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.shop.opensocial.mediated.services;

import com.shop.opensocial.mediated.types.GadgetContextMediator;
import javax.servlet.http.HttpServletRequest;

/**
 * @author Jordan Zimmerman
 */
public interface GadgetContextHandlerMediator
{
	/**
	 * Produce a gadget context from the HTTP request.
	 *
	 * @param request The request
	 * @return A valid context
	 * @throws Exception errors
	 */
	public GadgetContextMediator getGadgetContextFromRequest(HttpServletRequest request) throws Exception;

	/**
	 * Return the number of minutes to cache content
	 *
	 * @return minutes or 0 to use a default value
	 */
	public int getCacheTTLMinutes();
}
